serenade 0.3.0.1

data/lib/serenade.rb

@@ -0,0 +1,6 @@
+require "serenade/version"
+require "serenade/renderer"
+
+# Serenade for Ruby. See {Serenade::Renderer} for the view renderer.
+module Serenade
+end

data/lib/serenade/rails.rb

@@ -0,0 +1,11 @@
+require "serenade/sprockets"
+require "rails/engine"
+
+module Serenade
+  # Creating an empty Rails engine will make Rails add Serenade to
+  # the load path. As a result, you can require serenade.js in your
+  # assets without having to register the load path manually through
+  # Sprockets.
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/serenade/renderer.rb

@@ -0,0 +1,43 @@
+require "execjs"
+require "multi_json"
+
+module Serenade
+  # Absolute path to the directory containing the Serenade assets.
+  ASSET_PATH = File.expand_path("../assets/javascripts", File.dirname(__FILE__))
+
+  # Absolute path to the bundled serenade.js.
+  SERENADEJS_PATH = File.join(ASSET_PATH, "serenade.js")
+
+  # Serenade::Renderer compiles Serenade views into a Serenade AST.
+  class Renderer
+    # @return [String] name of the serenade view
+    attr_reader :name
+
+    # @return [String] content of the serenade view, before compilation
+    attr_reader :content
+
+    def initialize(name, content)
+      @name = name
+      @content = content
+    end
+
+    # Parse the Serenade view in {#content}.
+    #
+    # @return [Hash] Serenade view AST.
+    def parse
+      context = ExecJS.compile(File.read(SERENADEJS_PATH))
+      code = "Serenade.view(#{MultiJson.dump(content)}).parse()"
+      context.eval(code)
+    end
+
+    # Parse the Serenade view in {#content} and return a JavaScript string
+    # that will register the view with the designated {#name} in Serenade.
+    #
+    # This is the compiled output of a Serenade view template in Sprockets.
+    #
+    # @return [String] JavaScript output: `Serenade.view('view_name', view_ast)`
+    def render
+      "Serenade.view(#{MultiJson.dump(name)}, #{MultiJson.dump(parse)});"
+    end
+  end
+end

data/lib/serenade/sprockets.rb

@@ -0,0 +1,4 @@
+require "serenade/template"
+require "sprockets"
+
+Sprockets.register_engine(".serenade", Serenade::Template)

data/lib/serenade/template.rb

@@ -0,0 +1,26 @@
+require "serenade"
+require "tilt"
+
+module Serenade
+  # Tilt template for Serenade views. Tilt is used by Sprocket engines.
+  class Template < Tilt::Template
+    # @return [String] mime type assigned to all Serenade templates
+    def self.default_mime_type
+      "application/javascript"
+    end
+
+    # Tilt forces us to override this, or it will raise a NotImplementedError.
+    def prepare
+    end
+
+    # Used by tilt to render the template.
+    #
+    # @param scope
+    # @param [Hash] locals
+    # @return (see Serenade::Renderer#render)
+    def evaluate(scope, locals, &block)
+      name = scope.logical_path.gsub(/^views\//, "")
+      Serenade::Renderer.new(name, data.dup).render
+    end
+  end
+end

data/lib/serenade/version.rb

@@ -0,0 +1,4 @@
+module Serenade
+  # Serenade.js version this gem is bundled with.
+  VERSION = "0.3.0.1"
+end

data/serenade.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "serenade/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "serenade"
+  gem.version       = Serenade::VERSION
+
+  gem.authors       = ["Jonas Nicklas", "Kim Burgestrand"]
+  gem.email         = ["jnicklas@gmail.com", "kim@burgestrand.se"]
+  gem.license       = "MIT License"
+
+  gem.summary       = "Serenade.js for Ruby, Rails, and Sprockets"
+  gem.homepage      = "https://github.com/elabs/serenade.rb"
+  gem.description   = <<-TEXT
+- Use serenade.js with the Rails asset pipeline.
+- Use serenade.js with any sprockets application (middlemanapp, sinatra).
+- Prerender serenade.js views server-side, before it even reaches the client.
+TEXT
+
+  gem.add_dependency "execjs", ">= 0.3.0"
+  gem.add_dependency "multi_json"
+  gem.add_development_dependency "rspec", "~> 2.0"
+  gem.add_development_dependency "sprockets", "~> 2.0"
+  gem.add_development_dependency "rails", "~> 3.1"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

data/spec/serenade_spec.rb

@@ -0,0 +1,16 @@
+require "serenade"
+
+describe Serenade do
+  specify { defined?(Serenade::VERSION).should_not be_nil }
+
+  describe Serenade::Renderer do
+    describe "#parse" do
+      it "returns a parsed Sereande template" do
+        result = Serenade::Renderer.new("foo", 'h1 "Hello world"').parse
+        result["name"].should eq "h1"
+        result["children"][0]["type"].should eq "text"
+        result["children"][0]["value"].should eq "Hello world"
+      end
+    end
+  end
+end

data/spec/sprockets_spec.rb

@@ -0,0 +1,14 @@
+require "serenade/sprockets"
+
+describe "Serenade sprockets integration" do
+  it "registers the .serenade template engine" do
+    Sprockets.engines[".serenade"].should eq Serenade::Template
+  end
+
+  it "allows you to require serenade in your assets" do
+    env = Sprockets::Environment.new
+    env.append_path Serenade::ASSET_PATH
+
+    File.exists?(env.resolve "serenade").should be_true
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: serenade
+version: !ruby/object:Gem::Version
+  version: 0.3.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonas Nicklas
+- Kim Burgestrand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: ! '- Use serenade.js with the Rails asset pipeline.
+
+  - Use serenade.js with any sprockets application (middlemanapp, sinatra).
+
+  - Prerender serenade.js views server-side, before it even reaches the client.
+
+'
+email:
+- jnicklas@gmail.com
+- kim@burgestrand.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/assets/javascripts/serenade.js
+- lib/serenade.rb
+- lib/serenade/rails.rb
+- lib/serenade/renderer.rb
+- lib/serenade/sprockets.rb
+- lib/serenade/template.rb
+- lib/serenade/version.rb
+- serenade.gemspec
+- spec/serenade_spec.rb
+- spec/sprockets_spec.rb
+homepage: https://github.com/elabs/serenade.rb
+licenses:
+- MIT License
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Serenade.js for Ruby, Rails, and Sprockets
+test_files:
+- spec/serenade_spec.rb
+- spec/sprockets_spec.rb
+has_rdoc: