pannier 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b499e4d8880444acab12e7c82236e70102645d60
-  data.tar.gz: 9fc7791e4d6f6d2de4a7aad64bae4b2249932241
+  metadata.gz: 8446bb452a6e9dac934bda3bea546d78a4522be0
+  data.tar.gz: 33ffee121ef5394d3f21b5b83cda927ff71f9b56
 SHA512:
-  metadata.gz: 46f440d5c44c3dfb30489c42532840afd4b397e0a6bdad58f35f8614a3dd3e39204b34b5b2007ce899465fe268b9e20e08db404116aeac197f89a44787f8a585
-  data.tar.gz: 9e208521ae8caa253f9a52899a7c4b0ead6d9618b7e166848a42e8d1bb87b965af0ad26483dbaf38fa583859b9cc2cb0a10c436e6d613d072d3f582d1f4b8ef9
+  metadata.gz: 07a9fbfb6d7146d26ac14993f78813f978e768af192e0fd73b5fc938459407c4296803aa837af7b301cd817a3e43abd80bc38b86e49976bd5a53104b5f8cdd0c
+  data.tar.gz: a3213222ce4ca0dfedf894e7b96e158355187a32d1cb1893d432a57665aade8b4988d7556a344ddea6c20aa1759d8e32532733ced8eb603618ec3139811c4aa8

data/README.md

@@ -6,12 +6,28 @@ Pannier is a general-purpose Ruby asset processing tool. Its goal is to
 work the same way in any Rack environment. No Rails glue, no mandatory
 JavaScript or CSS libraries, preprocessors or gems.
 
+The configuration DSL was inspired by — but is ultimately quite
+different from — [rake-pipeline][rp]. The config describes a Rack
+application that handles asset processing (modification of file contents
+and file names, file concatenation). No decisions about
+uglifiers/optimisers/preprocessors have been made; that part is up to you.
+
+The interface for plugging any asset processing library into Pannier is very
+basic and inspired by Rack. The lack of a plugin ecosystem that binds you to any
+particular preprocessor is considered a feature.
+
+Pannier can also act as a Rack application that
+can be mounted (mapped to a path) within another Rack application, so
+it can serve your assets too. In that case, there are helper methods for
+including your assets in the view layer. Adding your own view helpers is
+easy too.
+
 ## Why?
 
 The Rails asset pipeline essentially consists of [Sprockets][sprockets]
 and a bunch of inscrutable Rails coupling. You generate a new Rails app
 and everything is setup for you. We call this "convention over configuration".
-It's a fine idea, but as soon as you need to ditch one of more of those
+It's a fine idea, but as soon as you need to ditch one or more of those
 conventions you'll be frustrated.
 
 I have found the
@@ -21,23 +37,6 @@ true where asset processing in Rails is concerned. I want explicit control
 over my assets and I don't mind spending a small amount of time on
 configuration.
 
-## What does it do?
-
-The configuration DSL was inspired by — but is ultimately quite
-different from — [rake-pipeline][rp]. The config describes a Rack
-application that handles asset processing (modification of file contents
-and file names, file concatenation). No decisions about
-uglifiers/optimisers/preprocessors have been made; that part is up to you.
-The interface to plug any of these libraries into Pannier is very simple
-and inspired by Rack. The lack of a plugin ecosystem that binds you to any
-particular preprocessor is considered a feature.
-
-In some cases the above is all you'll need, but the application
-can also be mounted (mapped to a path) within another Rack application, so
-it can serve your assets too. In that case, there are helper methods for
-including your assets in the view layer. Adding your own view helpers is
-easy too.
-
 ## Getting started
 
 Create a config file in the root of your project named `.assets.rb`. The
@@ -61,6 +60,33 @@ package :styles do
 end
 ```
 
+```bash
+$ pannier process
+```
+
+Your stylesheets have now been quuxified and concatenated into
+`public/main.min.css`.
+
+Modifiers are just Ruby *callables*; blocks, procs, lambdas, objects that
+respond to `call`. They are executed in order of specification. Here's a
+typical use case.
+
+```ruby
+require 'digest'
+# ...
+
+package :styles do
+  # ...
+
+  modify { |content, _|  [foo(content), _] }
+  modify { |content, _|  [bar(content), _] }
+  concat 'main'
+  modify do |content, basename|
+    [content, "#{basename}-#{Digest::MD5.hexdigest(content)}.min.css"]
+  end
+end
+```
+
 To understand further, you can [browse the current features on relish][relish].
 
 ## Contributing

data/lib/pannier.rb

@@ -13,32 +13,4 @@ module Pannier
     block = eval("proc { #{config} }", TOPLEVEL_BINDING, path, 0)
     App.build(env_name, &block)
   end
-
-  def self.prime(path, env_name = 'development')
-    app = load(path, env_name)
-    if manifest_exists?(app, env_name)
-      manifest = load_manifest(app, env_name)
-      app.prime!(manifest)
-    end
-    app
-  end
-
-  def self.rackup!(ru, path = './.assets.rb')
-    app = prime(path, ENV['RACK_ENV'])
-    ru.map(app.root) { run(app) }
-    app
-  end
-
-  private
-
-    def self.load_manifest(app, env_name)
-      path = File.join(app.input_path, ".assets.#{env_name}.json")
-      json = File.read(path)
-      MultiJson.load(json, :symbolize_keys => true)
-    end
-
-    def self.manifest_exists?(app, env_name)
-      path = File.join(app.input_path, ".assets.#{env_name}.json")
-      File.exists?(path)
-    end
 end

data/lib/pannier/app.rb

@@ -9,7 +9,7 @@ module Pannier
   class App
     extend DSL
 
-    attr_reader :env, :root, :input_path, :output_path,
+    attr_reader :env, :input_path, :output_path,
                 :behaviors, :packages
 
     def initialize(env_name = 'development')
@@ -17,10 +17,6 @@ module Pannier
       @behaviors, @packages, @root = {}, [], '/'
     end
 
-    def set_root(path)
-      @root = path
-    end
-
     def set_input(path)
       @input_path = File.expand_path(path)
     end
@@ -57,10 +53,6 @@ module Pannier
         @locals ||= OpenStruct.new(:env => env.name)
       end
 
-      def root(path)
-        set_root(path)
-      end
-
       def input(path)
         set_input(path)
       end

data/lib/pannier/mounted.rb

@@ -5,3 +5,33 @@ require 'pannier/mounted/app'
 require 'pannier/mounted/asset'
 require 'pannier/mounted/package'
 require 'pannier/mounted/tags'
+
+module Pannier
+  def self.prime(path, env_name = 'development')
+    app = load(path, env_name)
+    if manifest_exists?(app, env_name)
+      manifest = load_manifest(app, env_name)
+      app.prime!(manifest)
+    end
+    app
+  end
+
+  def self.rackup(ru, path = './.assets.rb')
+    app = prime(path, ENV['RACK_ENV'])
+    ru.map(app.mount_path) { run(app) }
+    app
+  end
+
+  private
+
+    def self.load_manifest(app, env_name)
+      path = File.join(app.input_path, ".assets.#{env_name}.json")
+      json = File.read(path)
+      MultiJson.load(json, :symbolize_keys => true)
+    end
+
+    def self.manifest_exists?(app, env_name)
+      path = File.join(app.input_path, ".assets.#{env_name}.json")
+      File.exists?(path)
+    end
+end

data/lib/pannier/mounted/app.rb

@@ -3,6 +3,12 @@ require 'pannier/app'
 module Pannier
   class App
 
+    attr_reader :mount_path
+
+    def set_mount_path(path)
+      @mount_path = path
+    end
+
     def prime!(manifest)
       manifest.each do |name, paths|
         if (pkg = self[name])
@@ -28,5 +34,13 @@ module Pannier
       handler.call(env)
     end
 
+    dsl do
+
+      def mount(path)
+        set_mount_path(path)
+      end
+
+    end
+
   end
 end

data/lib/pannier/mounted/asset.rb

@@ -4,9 +4,10 @@ module Pannier
   class Asset
 
     def serve_from(app)
-      asset_path, app_output_path = Pathname.new(path), Pathname.new(app.output_path)
-      relative_path = asset_path.relative_path_from(app_output_path)
-      File.join(app.root, relative_path.to_s)
+      asset_path      = Pathname.new(path)
+      app_output_path = Pathname.new(app.output_path)
+      relative_path   = asset_path.relative_path_from(app_output_path)
+      File.join(*['/', app.mount_path, relative_path.to_s].compact)
     end
 
   end

data/lib/pannier/package.rb

@@ -1,4 +1,3 @@
-require 'delegate'
 require 'ostruct'
 require 'pathname'
 require 'set'

data/lib/pannier/version.rb

@@ -1,3 +1,3 @@
 module Pannier
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pannier
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joe Corcoran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-02 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -192,9 +192,8 @@ dependencies:
         version: 0.6.2
 description: |
   Pannier is a Ruby tool for the processing of web assets like CSS
-  and JavaScript files, both programatically and from the command line. It can
-  be used as a standalone asset organizer or mounted within any Rack-compatible
-  application.
+  and JavaScript files. It can be used as a standalone asset organizer or mounted
+  within any Rack-compatible application.
 email:
 - joecorcoran@gmail.com
 executables:
@@ -243,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: A simple, portable asset processing tool for Ruby web apps