sprock-assets 0.0.1 → 0.9.0

data/.gitignore

@@ -1 +1 @@
-rack-assets-*.gem
+sprock-assets-*.gem

data/Gemfile.lock

@@ -7,10 +7,27 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.3.2)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.5)
+      ffi (~> 1.0, >= 1.0.6)
     diff-lcs (1.1.3)
+    ffi (1.1.5)
     hike (1.2.1)
+    libwebsocket (0.1.5)
+      addressable
+    mime-types (1.19)
     multi_json (1.3.6)
+    nokogiri (1.5.5)
     rack (1.4.1)
+    rack-test (0.6.2)
+      rack (>= 1.0)
     rake (0.9.2.2)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
@@ -20,17 +37,27 @@ GEM
     rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.3)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.25.0)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
     sprockets (2.6.0)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
     tilt (1.3.3)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  capybara
+  rack
   rake
   rspec
   sprock-assets!

data/bin/sprock-assets

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'sprock_assets'
+
+if %w(-v --version).include? ARGV.first
+  puts "sprock-assets, version #{SprockAssets::VERSION}"
+elsif 'generate_assets' == ARGV.first
+  SprockAssets.new(nil).generate_assets
+else
+  puts (<<-EOS).gsub('^  ', '')
+  usage: sprock-assets [switches] [commands]
+    switches:
+      -v/--version      displays version number
+      -h/--help         displays this help
+    commands:
+      generate_assets   generates default assets
+  EOS
+end

data/lib/sprock_assets.rb

@@ -1,23 +1,59 @@
-require 'sprock_assets/version'
+require 'fileutils'
 require 'sprockets'
+require 'sprock_assets/version'
 
 class SprockAssets
-  def initialize app
-    puts ">> Asset compiler enabled"
+  # Public: Gets/Sets the Rack application instance.
+  attr_accessor :app
+  # Public: Gets/Sets the middleware settings.
+  attr_accessor :settings
+  # Public: Gets/Sets the Sprockets Enviroment.
+  attr_accessor :assets
+
+  # Public: Initialize SprockAssets a middleware.
+  #
+  # app - The current Rack app.
+  # settings - A hash of the asset path settings.
+  def initialize(app, settings={})
     @app = app
-    @env = Sprockets::Environment.new(Dir.pwd) do |env|
-      env.logger = Logger.new(STDOUT)
+    @settings = {
+      assets_path:      'app',
+      javascripts_path: 'app/assets/javascripts',
+      stylesheets_path: 'app/assets/stylesheets',
+    }.merge(settings)
+
+    @assets = Sprockets::Environment.new(Dir.pwd) do |assets|
+      assets.logger = Logger.new(STDOUT)
+      assets.append_path @settings[:assets_path]
+      assets.append_path @settings[:javascripts_path]
+      assets.append_path @settings[:stylesheets_path]
     end
-    @env.append_path 'app'
-    @env.append_path 'app/assets/stylesheets'
-    @env.append_path 'app/assets/javascripts'
   end
 
-  def call env
-    if env['PATH_INFO'][/^\/assets/].present?
-      @env.call env
-    else
+  # Public: A rack middleware call method routing URLs under /assets/ to the SprockAssets middleware.
+  def call(env)
+    if env['PATH_INFO'][/^\/assets/].nil?
       @app.call env
+    else
+      @assets.call env
+    end
+  end
+
+  # Public: Generates the configured file structure for an applications assets.
+  def generate_assets
+    FileUtils.mkdir_p "#{@settings[:javascripts_path]}/coffee"
+    FileUtils.mkdir_p "#{@settings[:stylesheets_path]}/scss"
+    File.open("#{@settings[:javascripts_path]}/application.js", 'w') do |application_js|
+      application_js << (<<-EOS).gsub('      ', '')
+      //= require_tree ./coffee
+      EOS
+    end
+    File.open("#{@settings[:stylesheets_path]}/application.css", 'w') do |application_css|
+      application_css << (<<-EOS).gsub('      ', '')
+      /*
+       *= require_tree ./scss
+       */
+      EOS
     end
   end
 end

data/lib/sprock_assets/version.rb

@@ -1,3 +1,4 @@
 class SprockAssets
-  VERSION = '0.0.1'
+  # Public: String version number of SprockAsset gem.
+  VERSION = '0.9.0'
 end

data/readme.md

@@ -1,15 +1,57 @@
 # SprockAssets
+
 SprockAssets is a Rack Middleware you can include in your application for compiling your assets on the fly with Sprockets.
 
-# How To Use
+## Usage
+
+Here's how to use it.
 
-Install the gem by adding it to your `Gemfile` and doing a bundle install.
+### Add it to your Gemfile
 
     gem 'sprock-assets', require 'sprock_assets'
 
+### Vanilla Rack apps
+
 Add a use to your `config.ru`
 
     use SprockAssets
 
+### Sinatra
+
+If you're using Sinatra, you can use the flash hash just like in Rails:
+
+    require 'sinatra/base'
+    require 'sprock_assets'
+
+    class MyApp < Sinatra::Base
+      use SprockAssets
+    end
+
+### Generate default assets
+
+Use the built in generator to generate some default assets. 
+
+    sprock-assets generate_assets
+
+It will create a directory structure and default assets based on the configured settings.
+
+    tree app/
+    app/
+    └── assets
+        ├── javascripts
+        │   ├── application.js
+        │   └── coffee
+        └── stylesheets
+            ├── application.css.scss
+            └── scss
+
+### Serve compiled assets
+
+    ruby config.ru
+    curl http://localhost/assets/stylesheets/application.css
+    curl http://localhost/assets/javascripts/application.js
+    
+Your compiled assets will now be served at their corresponding URIs.
+
 ### License
 WTFPL &copy; 2012 Nick Barth

data/spec/sprock_assets_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe SprockAssets do
+  context 'on Rack initialize' do
+    it 'takes in custom paths' do
+      env = Sprockets::Environment.any_instance
+      env.should_receive(:append_path).with('ASSETS_PATH')
+      env.should_receive(:append_path).with('JAVASCRIPTS_PATH')
+      env.should_receive(:append_path).with('STYLESHEETS_PATH')
+      SprockAssets.new nil, assets_path:      'ASSETS_PATH',
+                            javascripts_path: 'JAVASCRIPTS_PATH',
+                            stylesheets_path: 'STYLESHEETS_PATH'
+    end
+  end
+
+  context 'on Rack request' do
+    it 'should invoke Sprocket on URIs under /assets/' do
+      rack_app = SprockAssets.new nil
+      rack_app.assets.should_receive(:call)
+      rack_app.call 'PATH_INFO' => '/assets/'
+    end
+
+    it 'should not invoke Sprocket for other URIs' do
+      rack_app = SprockAssets.new double
+      rack_app.app.should_receive(:call)
+      rack_app.call 'PATH_INFO' => '/other/'
+    end
+  end
+
+  context 'on generate asset call' do
+    before(:each) do
+      FileUtils.stub(:mkdir_p)
+      File.stub(:open)
+    end
+
+    it 'should create the correct folders' do
+      FileUtils.should_receive(:mkdir_p).with('app/assets/stylesheets/scss')
+      FileUtils.should_receive(:mkdir_p).with('app/assets/javascripts/coffee')
+      SprockAssets.new(nil).generate_assets
+    end
+
+    it 'should write an application.css and a application.js file' do
+      File.should_receive(:open).with('app/assets/javascripts/application.js', 'w')
+      File.should_receive(:open).with('app/assets/stylesheets/application.css', 'w')
+      SprockAssets.new(nil).generate_assets
+    end
+  end
+end

data/sprock_assets.gemspec

@@ -11,10 +11,13 @@ Gem::Specification.new do |gem|
   gem.summary       = 'A Ruby Gem for compiling assets through Sprock.'
   gem.description   = 'SprockAssets is a Rack Middleware you can include in your application for compiling your assets on the fly with Sprockets.'
   gem.homepage      = 'https://github.com/nickbarth/SprockAssets'
+  gem.executables   = ['sprock-assets']
 
   gem.add_dependency('sprockets')
   gem.add_development_dependency('rake')
+  gem.add_development_dependency('rack')
   gem.add_development_dependency('rspec')
+  gem.add_development_dependency('capybara')
 
   gem.files         = `git ls-files`.split($/)
   gem.test_files    = gem.files.grep /spec/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprock-assets
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,11 +75,28 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: SprockAssets is a Rack Middleware you can include in your application
   for compiling your assets on the fly with Sprockets.
 email:
 - nick@nickbarth.ca
-executables: []
+executables:
+- sprock-assets
 extensions: []
 extra_rdoc_files: []
 files:
@@ -72,12 +105,12 @@ files:
 - Gemfile
 - Gemfile.lock
 - Rakefile
+- bin/sprock-assets
 - lib/sprock_assets.rb
 - lib/sprock_assets/version.rb
 - readme.md
-- spec/rack_assets_spec.rb
 - spec/spec_helper.rb
-- sprock-assets-0.0.1.gem
+- spec/sprock_assets_spec.rb
 - sprock_assets.gemspec
 homepage: https://github.com/nickbarth/SprockAssets
 licenses: []
@@ -105,6 +138,6 @@ specification_version: 3
 summary: A Ruby Gem for compiling assets through Sprock.
 test_files:
 - .rspec
-- spec/rack_assets_spec.rb
 - spec/spec_helper.rb
+- spec/sprock_assets_spec.rb
 - sprock_assets.gemspec

data/spec/rack_assets_spec.rb

@@ -1,5 +0,0 @@
-require 'spec_helper'
-
-describe SprockAssets do
-  it 'should have tests'
-end