smallvictories 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ec4b9886a3ede16fc3d173852d14e53fd762a38
-  data.tar.gz: 925234d3af8439d6f45381a4701f7c0331192ea9
+  metadata.gz: b519e1b389b4f5ad88c228896a66e099bf080c03
+  data.tar.gz: 68f66717c9bf8100b1773d7061e8c54842c1a5ad
 SHA512:
-  metadata.gz: 43e26f3eec4ca433f45e629dddb541e1a39cbfeadb87187d1c3628b886d92260018c6f0b15d8077d9bad0886b832b1d6a94476b46163cd02c62120ed7b83b23b
-  data.tar.gz: a91f54da2046b2cff5dff279ad4c644354e801a2ff4cf0e900c060186fd9feadab22adb3ebfb4519cdba4b0d90caf459b4a02a546858d6252806b01c62de9ba2
+  metadata.gz: 082fbefe8a57fad2cc0111d0f36658032a1ff262249fdc19d36a881041ab8992e0617190140c32bceab1bca007923239523c1531c2450fc4490dd415a9eced6a
+  data.tar.gz: fbf653203cba09588114ce8c81c2597a842beac72d24c93106b3e44b4922a85458e8856b22ebde00af7191dc52a9426ab6c9d19f3ba9b7f0e288c84d4ef23e97

data/README.md

@@ -5,7 +5,7 @@ A command line utility for building websites.
 ## What does it do?
 
 The Small Victories gem compiles Sass/CSS and JS/CoffeeScript files into a single Stylesheet and
-Javascript file and renders HTML and Liquid files into a destination folder.
+JavaScript file and renders HTML and Liquid files into a destination folder.
  
 [Sprockets](https://github.com/rails/sprockets) looks for main Sass/CSS and JS/CoffeeScript files and compiles
 multiple Sass/CSS and JS/CoffeeScript files into a single CSS and JS file.
@@ -23,13 +23,17 @@ be copied over to the destination folder.
 ### Basic Folder Structure
 
 ```text
-project
-├── _includes
-├── _layout.liquid
-├── _sv_custom.css
-├── _sv_custom.js
-│
-└── index.html
+dev
+  ├── _includes
+  │ └── _head.liquid
+  ├── _layout.liquid
+  ├── _sv_custom.css
+  ├── _sv_custom.js
+  └── index.liquid
+prod
+  ├── _sv_custom.css
+  ├── _sv_custom.js
+  └── index.html
 ```
 
 ## How does it work with Small Victories?
@@ -43,6 +47,42 @@ Victories site folder e.g. `~/Dropbox/Small Victories/liberal coyote`.
 Now when you watch or build your site it will output the files into your Dropbox
 folder, which in turn will trigger Small Victories to rebuild your site.
 
+### Example Config
+
+```yaml
+source: ''
+destination: '~/Dropbox/Small Victories/my-site'
+stylesheet: '_sv_custom.css'
+javascript: '_sv_custom.js'
+layout: '_layout.liquid'
+includes: '_includes'
+```
+
+### Example Folder Structure
+
+```text
+Code
+  my-site
+    ├── _includes
+    │ └── _head.liquid
+    ├── _config.yml
+    ├── _layout.liquid
+    ├── _sv_custom.css
+    ├── _sv_custom.js
+    └── index.liquid
+
+Dropbox
+  └── Small Victories
+    └──my-site
+      ├── _sv_custom.css
+      ├── _sv_custom.js
+      └── index.html
+```
+
+## Why is there now web server?
+
+There are other static site generators (like [Jekyll](http://jekyllrb.com/) or [Middleman](https://middlemanapp.com/)) that you can use to fire up a web server (and more!), Small Victories helps you build a static site for hosting on Small Victories, so if you don't need anything more than a static HTML file that can be dropped into your Small Victories folder.
+
 ## Installation
 
 ```
@@ -63,9 +103,9 @@ run from.
 
 ### Default Configuration
 
-```
-source: ''
-destination: '_site'
+```yaml
+source: 'dev'
+destination: 'prod'
 stylesheet: '_sv_custom.css'
 javascript: '_sv_custom.js'
 layout: '_layout.liquid'

data/bin/sv

@@ -9,6 +9,7 @@ def help
   Commands:
     bootstrap, bootstrap FOLDER     Setup folder with default files
     compile                         Compile files
+    open                            Open index.html in destination folder
     watch                           Watch for changes and compile files
     help                            Prints this help document
     version                         Prints the small victories gem version
@@ -35,6 +36,11 @@ def compile
   compiler.compile_html
 end
 
+def open
+  config = SmallVictories::Configuration.new
+  system("open #{config.full_destination_path}index.html")
+end
+
 def watch
   config = SmallVictories::Configuration.new
   compiler = SmallVictories::Compiler.new(config: config)
@@ -51,6 +57,8 @@ when 'bootstrap'
   bootstrap ARGV[1]
 when 'compile'
   compile
+when 'open'
+  open
 when 'watch'
   watch
 else

data/lib/smallvictories/builder.rb

@@ -12,6 +12,7 @@ module SmallVictories
     def setup folder=nil
       self.folder = "#{folder.chomp("/").reverse.chomp("/").reverse}/" if folder
       setup_directory folder_path
+      setup_directory folder_source_path
       setup_config
       setup_stylesheet
       setup_javascript
@@ -19,7 +20,11 @@ module SmallVictories
     end
 
     def folder_path
-      "#{config.full_source_path}#{folder}"
+      "#{ROOT}/#{folder}"
+    end
+
+    def folder_source_path
+      "#{folder_path}/#{config.source}/"
     end
 
     private
@@ -56,18 +61,18 @@ module SmallVictories
     end
 
     def setup_stylesheet
-      create_src_file('stylesheet.css', "#{folder_path}#{config.stylesheet}")
+      create_src_file('stylesheet.css', "#{folder_source_path}#{config.stylesheet}")
     end
 
     def setup_javascript
-      create_src_file('javascript.js', "#{folder_path}#{config.javascript}")
+      create_src_file('javascript.js', "#{folder_source_path}#{config.javascript}")
     end
 
     def setup_html
-      setup_directory("#{folder_path}#{config.includes}")
-      create_src_file('layout.liquid', "#{folder_path}#{config.layout}")
-      create_src_file('index.liquid', "#{folder_path}/index.liquid")
-      create_src_file('head.liquid', "#{folder_path}#{config.includes}/_head.liquid")
+      setup_directory("#{folder_source_path}#{config.includes}")
+      create_src_file('head.liquid', "#{folder_source_path}#{config.includes}/_head.liquid")
+      create_src_file('layout.liquid', "#{folder_source_path}#{config.layout}")
+      create_src_file('index.liquid', "#{folder_source_path}index.liquid")
     end
   end
 end

data/lib/smallvictories/compiler.rb

@@ -51,6 +51,7 @@ module SmallVictories
           else
             html = liquid.render('config' => { 'stylesheet' => config.stylesheet, 'javascript' => config.javascript })
           end
+          Dir.mkdir(config.full_destination_path) unless File.exists?(config.full_destination_path)
           File.open("#{config.full_destination_path}#{output_file_name}", 'w') { |file| file.write(html) }
           SmallVictories.logger.info "compiled #{config.destination}/#{output_file_name}"
         rescue => e
@@ -58,6 +59,7 @@ module SmallVictories
         end
       end
     end
+
     def package bundles=[config.stylesheet, config.javascript]
       sprockets = Sprockets::Environment.new(ROOT) do |environment|
         environment.js_compressor  = :uglify

data/lib/smallvictories/configuration.rb

@@ -21,7 +21,7 @@ module SmallVictories
     end
 
     def full_source_path
-      "#{ROOT}/#{source}"
+      "#{ROOT}/#{source}/"
     end
 
     def destination

data/lib/smallvictories/constants.rb

@@ -1,7 +1,7 @@
 module SmallVictories
   CONFIG_FILE = '_config.yml'
-  DEFAULT_SOURCE = ''
-  DEFAULT_DESTINATION = '_site'
+  DEFAULT_SOURCE = 'dev'
+  DEFAULT_DESTINATION = 'prod'
   DEFAULT_STYLESHEET = '_sv_custom.css'
   DEFAULT_JAVASCRIPT = '_sv_custom.js'
   DEFAULT_LAYOUT = '_layout.liquid'

data/lib/smallvictories/version.rb

@@ -1,3 +1,3 @@
 module SmallVictories
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/smallvictories/watcher.rb

@@ -36,14 +36,14 @@ module SmallVictories
     end
 
     def watch
-      listener = build_listener
-      listener.start
       SmallVictories.logger.debug "👋"
       SmallVictories.logger.debug "👀"
+      listener = build_listener
+      listener.start
 
       trap("INT") do
         listener.stop
-        SmallVictories.logger.warn "✋  Halting auto-regeneration."
+        puts "✋  Halting auto-regeneration."
         exit 0
       end
 

data/smallvictories.gemspec

@@ -18,13 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency 'autoprefixer-rails', "~> 6.0"
+  spec.add_runtime_dependency 'coffee-script', '~> 2.4'
+  spec.add_runtime_dependency 'listen', '~> 3.0'
+  spec.add_runtime_dependency 'liquid', "~> 3.0"
   spec.add_runtime_dependency 'sassc', "~> 1.6"
   spec.add_runtime_dependency 'sprockets', '~> 3.4'
-  spec.add_runtime_dependency 'listen', '~> 3.0'
   spec.add_runtime_dependency 'uglifier', '~> 2.7'
-  spec.add_runtime_dependency 'coffee-script', '~> 2.4'
-  spec.add_runtime_dependency 'liquid', "~> 3.0"
-  spec.add_runtime_dependency 'autoprefixer-rails', "~> 6.0"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/spec/builder_spec.rb

@@ -3,19 +3,19 @@ require 'spec_helper'
 describe SmallVictories do
   let(:builder) { SmallVictories::Builder.new(config: SmallVictories::Configuration.new) }
 
-  context 'with no folder' do
+  context 'with folder' do
     it 'sets up default files' do
       builder.setup 'spec/fixtures/new'
       expect(File.exists?('fixtures/new/_config.yml')).to eq true
-      expect(File.exists?('fixtures/new/_layout.liquid')).to eq true
-      expect(File.exists?('fixtures/new/index.liquid')).to eq true
-      expect(File.exists?('fixtures/new/_includes/_head.liquid')).to eq true
-      expect(File.exists?('fixtures/new/_sv_custom.js')).to eq true
-      expect(File.exists?('fixtures/new/_sv_custom.css')).to eq true
+      expect(File.exists?('fixtures/new/dev/_layout.liquid')).to eq true
+      expect(File.exists?('fixtures/new/dev/index.liquid')).to eq true
+      expect(File.exists?('fixtures/new/dev/_includes/_head.liquid')).to eq true
+      expect(File.exists?('fixtures/new/dev/_sv_custom.js')).to eq true
+      expect(File.exists?('fixtures/new/dev/_sv_custom.css')).to eq true
     end
 
     after do
-      %w(fixtures/new/_config.yml fixtures/new/index.liquid fixtures/new/_sv_custom.css fixtures/new/_sv_custom.js fixtures/new/_includes/_head.liquid fixtures/new/_layout.liquid).each { |path| clean_file(path) }
+      %w(fixtures/new/_config.yml fixtures/new/dev/index.liquid fixtures/new/dev/_sv_custom.css fixtures/new/dev/_sv_custom.js fixtures/new/dev/_includes/_head.liquid fixtures/new/dev/_layout.liquid).each { |path| clean_file(path) }
     end
   end
 end

data/spec/configuration_spec.rb

@@ -5,11 +5,11 @@ describe SmallVictories do
 
   context 'with no config file' do
     it 'defaults to source directory' do
-      expect(configuration.source).to eq ''
+      expect(configuration.source).to eq 'dev'
     end
 
     it 'defaults to destination directory' do
-      expect(configuration.destination).to eq '_site'
+      expect(configuration.destination).to eq 'prod'
     end
 
     it 'defaults stylesheet file' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smallvictories
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Michael Dijkstra
@@ -11,33 +11,33 @@ cert_chain: []
 date: 2016-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sassc
+  name: autoprefixer-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: sprockets
+  name: coffee-script
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -53,61 +53,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: uglifier
+  name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: coffee-script
+  name: sassc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: liquid
+  name: sprockets
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: autoprefixer-rails
+  name: uglifier
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement