jquery_expand_assets 0.0.3

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tags

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in expand_assets.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matt Fletcher
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# jquery.expand assets
+
+A Sprockets processor that wraps html in a jquery.expand function. It is specifically meant to work within the Rails asset pipeline.
+
+The processor outputs CoffeeScript, so you'll need to have the result be processed by the CoffeeScript processor.
+
+## Creating and using templates
+
+Create your templates in a directory named `app/assets/javascripts/templates`. Organize your templats within subdirectories. I personally organize them based on what resource they're associated with.
+
+Write your template and wrap it in a root element.
+
+Example: `app/assets/javascripts/templates/articles/_entry.js.coffee.expand`
+    <div>
+      <h2 class='name'></h2>
+      <p class='content'></p>
+    </div>
+
+Your template is now available to Javascript as a function on the `JST` object. Pass an expand directive to the function and you'll be given the result minus the wrapper element.
+
+Example: see `articles/_entry.js.coffee.expand` above
+    directive = { name: 'Joe', content: 'I love Smurfs.' }
+    html = JST['articles/entry'](directive)
+    $('body').append(html)
+
+In this example, the result html will be:
+    <h2 class='name'>Joe<h2>
+    <p class='content'>I love Smurfs.</p>
+
+## Naming conventions
+
+Templates are named on the `JST` object based on their filename. Directories under `app/assets/javascripts/templates` are preserved. If the template's filename starts with an underscore, the underscore is removed from the name.
+
+Examples:
+
+`articles/_entry.js.coffee.expand` becomes `articles/entry`  
+`articles/comments/_comment.js.coffee.expand` becomes `articles/comments/comment`  
+`articles/response.js.coffee.expand` becomes `articles/response`  
+
+## Resources
+
+* [jquery.expand](https://github.com/atomicobject/jquery.expand)
+* [jquery.expand examples](http://spin.atomicobject.com/2011/07/10/jquery-expand-examples/)
+
+## Thanks so much!
+
+I'd like to give a huge 'thank you' to the [Sprockets](https://github.com/sstephenson/sprockets), [haml_assets](https://github.com/infbio/haml_assets), and [haml_coffee_assets](https://github.com/netzpirat/haml_coffee_assets) projects. Without their examples, I'm not sure I would have figured out the code required to create the Rails engine and Tilt template.
+
+Authors
+=======
+* Matt Fletcher (fletcher@atomicobject.com)
+* © 2012 [Atomic Object](http://www.atomicobject.com/)
+* More Atomic Object [open source](http://www.atomicobject.com/pages/Software+Commons) projects

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = %w[ lib ]
+  t.warning = true
+  t.verbose = true
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task default: :test

data/jquery_expand_assets.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/jquery_expand_assets/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Matt Fletcher"]
+  gem.email         = ["fletcher@atomicobject.com"]
+  gem.description   = %q{Sprockets processor for jquery.expand templates}
+  gem.summary       = %q{Sprockets processor for jquery.expand templates}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "jquery_expand_assets"
+  gem.require_paths = ["lib"]
+  gem.version       = JqueryExpandAssets::VERSION
+
+  gem.add_runtime_dependency 'tilt', '~>1'
+
+  gem.add_development_dependency 'rake', '~>0.9'
+  gem.add_development_dependency 'minitest', '~>3'
+end

data/lib/jquery_expand_assets/engine.rb

@@ -0,0 +1,8 @@
+module JqueryExpandAssets
+  class Engine < ::Rails::Engine
+    initializer "sprockets.jquery-expand", :after => "sprockets.environment", :group => :all do |app|
+      next unless app.assets
+      app.assets.register_engine('.expand', JqueryExpandProcessor)
+    end
+  end
+end

data/lib/jquery_expand_assets/jquery_expand_processor.rb

@@ -0,0 +1,22 @@
+require 'tilt'
+
+module JqueryExpandAssets
+  class JqueryExpandProcessor < Tilt::Template
+    # implemented for the superclass's template method
+    def prepare; end
+
+    def evaluate(scope, locals, &block)
+      name = scope.logical_path.sub(/^templates\//, '').sub(%r{/?_(.*)$}, '/\1')
+      <<-COFFEE
+        this.JST ||= {}
+        template = null
+        html = """
+               #{data}
+               """
+        this.JST[#{name.inspect}] = (directive) ->
+          template ||= $(html)
+          template.expand(directive).children()
+      COFFEE
+    end
+  end
+end

data/lib/jquery_expand_assets/version.rb

@@ -0,0 +1,3 @@
+module JqueryExpandAssets
+  VERSION = '0.0.3'
+end

data/lib/jquery_expand_assets.rb

@@ -0,0 +1,6 @@
+require 'jquery_expand_assets/version'
+require 'jquery_expand_assets/engine'
+
+module JqueryExpandAssets
+  autoload :JqueryExpandProcessor, 'jquery_expand_assets/jquery_expand_processor'
+end

data/test/jquery_expand_processor_test.rb

@@ -0,0 +1,54 @@
+require 'minitest/autorun'
+require 'ostruct'
+require 'jquery_expand_assets/jquery_expand_processor'
+
+class JqueryExpandProcessorTest < MiniTest::Unit::TestCase
+  def test_wraps_content_with_expand_function
+    result = process content: "<p><div>butters cookies</div></p>"
+
+    assert_match "<p><div>butters cookies</div></p>", result
+    assert_match %r{\.expand\(directive\)\.children\(\)}, result
+  end
+
+  def test_names_the_template_after_the_file_name
+    result = process filename: 'templates/projects/_comment'
+
+    assert_match 'this.JST["projects/comment"]', result
+  end
+
+  def test_handles_file_names_with_multiple_levels_of_nesting
+    result = process filename: 'templates/projects/comments/concerns/_alert'
+
+    assert_match 'this.JST["projects/comments/concerns/alert"]', result
+  end
+
+  def test_does_not_yet_handle_file_names_with_one_level_of_nesting
+    result = process filename: 'templates/_comment'
+
+    refute_match 'this.JST["comment"]', result
+  end
+
+  def test_handles_template_names_without_leading_underscore
+    result = process filename: 'templates/users/avatar'
+
+    assert_match 'this.JST["users/avatar"]', result
+  end
+
+  private
+  def process(optz)
+    content, filename = optz.values_at(:content, :filename)
+    content ||= "<b>grover</b>"
+    filename ||= "butters/_cookies"
+
+    processor = JqueryExpandAssets::JqueryExpandProcessor.new do content end
+    processor.evaluate(os(logical_path: filename), nil)
+  end
+
+  def build_with_content(content='')
+    JqueryExpandAssets::JqueryExpandProcessor.new do content end
+  end
+  alias_method :build, :build_with_content
+
+  def scope(logical_path = ''); os(logical_path: logical_path); end
+  def os(*args); OpenStruct.new(*args); end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: jquery_expand_assets
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Matt Fletcher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Sprockets processor for jquery.expand templates
+email:
+- fletcher@atomicobject.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jquery_expand_assets.gemspec
+- lib/jquery_expand_assets.rb
+- lib/jquery_expand_assets/engine.rb
+- lib/jquery_expand_assets/jquery_expand_processor.rb
+- lib/jquery_expand_assets/version.rb
+- test/jquery_expand_processor_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3627693289123550229
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3627693289123550229
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Sprockets processor for jquery.expand templates
+test_files:
+- test/jquery_expand_processor_test.rb